Documentação - Documentação

get https://betpay.iugu.com/api/v1/payin/external_id/{external_id}

Busca operação de recebimento.

Busca operação de recebimento pelo identificador do cliente.

Permissão necessária: betpay:payin.search

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Request

Path variables
external_id Required Type: string

Headers
WORKSPACE_ID Type: string ID do workspace Ex: 1D81KhKbYuVq9505Bz4Nk9

Response

200

Operação de recebimento encontrada

String

Código de identificação criado pela iugu

Ex: 16d8Tj4tFnLN6jySecOQBE

amount

Number

Valor da operação de recebimento

Ex: 10.0

payer_name

String

Nome do pagador da operação de recebimento

Ex: John Doe

payer_fiscal

String

Documento do pagador da operação de recebimento

Ex: 123456789

status

String
Enum: `pending`, `paid`, `partially_paid`, `refunded`, `canceled`

Estado do recebimento: - pending: Pendente de pagamento - paid: Pago - partially_paid: Pagamento parcial - refunded: Reembolsado - canceled: Recebimento cancelado

Ex: pending

created_at

String

Data e hora da criação do recebimento

Ex:

updated_at

String

Data e hora da última atualização do recebimento

Ex:

end_to_end_id

String

Identificador da operação financeira junto aos bancos

Ex: E60701190202502271705DY5AAAAAAA

webhook_status_code

Integer

Código recebido como resposta do cliente na chamada do webhook cadastrado

Ex: 200

refund_end_to_end_id

String

Identificador da operação financeira de reembolso junto aos bancos

Ex: D15111975202502210712320466AAAAA

refund_at

String

Data e hora em que o reembolso foi realizado

Ex:

paid_at

String

Data e hora em que o pagamento foi efetivado

Ex:

canceled_at

String

Data e hora em que o recebimento foi cancelado

Ex:

read_at

String

Data e hora em que o QRCode foi lido

Ex:

external_id

String

Código de identificação criado pelo cliente

Ex: IN1234

payment_sender_bank_name

String

Nome do banco do pagador

Ex: BANCO DO BRASIL S.A.

payment_sender_bank_account

String

Conta do pagador

Ex: 567890

payment_sender_bank_branch

String

Agência do pagador

Ex: 1234

payment_sender_bank_account_type

String

Tipo de conta do pagador (checking_account, salary_account, savings_account, payment_account)

Ex: checking_account

payment_sender_ispb

String

Código ispb do banco do pagador

Ex: 00000000

payment_sender_name

String

Nome do pagador

Ex: John Doe

payment_sender_fiscal_id

String

Document do pagador (mascarado)

Ex: 333.***.***-33

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
  "id": "16d8Tj4tFnLN6jySecOQBE",
  "amount": 10.0,
  "payer_name": "John Doe",
  "payer_fiscal": "123456789",
  "status": "pending",
  "created_at": "",
  "updated_at": "",
  "end_to_end_id": "E60701190202502271705DY5AAAAAAA",
  "webhook_status_code": 200,
  "refund_end_to_end_id": "D15111975202502210712320466AAAAA",
  "refund_at": "",
  "paid_at": "",
  "canceled_at": "",
  "read_at": "",
  "external_id": "IN1234",
  "payment_sender_bank_name": "BANCO DO BRASIL S.A.",
  "payment_sender_bank_account": "567890",
  "payment_sender_bank_branch": "1234",
  "payment_sender_bank_account_type": "checking_account",
  "payment_sender_ispb": "00000000",
  "payment_sender_name": "John Doe",
  "payment_sender_fiscal_id": "333.***.***-33"
}

404
Operação com o identificador externo não encontrada

Back

Cria um QRCode Pix para o recebimento de valores.

Forward

Busca operação de recebimento.